# ColumnedMapMapping.java

    package org.codefilarete.stalactite.mapping;

    import java.util.HashMap;
    import java.util.HashSet;
    import java.util.LinkedHashSet;
    import java.util.Map;
    import java.util.Map.Entry;
    import java.util.Set;
    import java.util.function.BiFunction;
    import java.util.function.Function;

    import org.codefilarete.reflection.PropertyAccessPoint;
    import org.codefilarete.reflection.PropertyMutator;
    import org.codefilarete.reflection.ReadWritePropertyAccessPoint;
    import org.codefilarete.stalactite.sql.ddl.structure.Column;
    import org.codefilarete.stalactite.sql.ddl.structure.Table;
    import org.codefilarete.stalactite.sql.result.ColumnedRow;
    import org.codefilarete.tool.Reflections;
    import org.codefilarete.tool.collection.Collections;
    import org.codefilarete.tool.function.Predicates;

    /**
     * A class that "roughly" persists a {@link Map} tom some {@link Column}s : mapping is made according to {@link Map} keys.
     *
     * @author Guillaume Mary
     */
    public abstract class ColumnedMapMapping<C extends Map<K, V>, K, V, T extends Table<T>> implements EmbeddedBeanMapping<C, T> {

    	private final T targetTable;
    	private final Set<Column<T, ?>> columns;
    	private final ToMapRowTransformer<C> rowTransformer;

    	/**
    	 * Constructor
    	 *
    	 * @param targetTable table to persist in
    	 * @param columns columns that will be used for persistent of Maps, expected to be a subset of targetTable columns
    	 * @param rowClass Class to instantiate for select from database
    	 */
    	public ColumnedMapMapping(T targetTable, Set<Column<T, ?>> columns, Class<C> rowClass) {
    		this.targetTable = targetTable;
    		this.columns = columns;
    		// We bind conversion on MapMappingStrategy conversion methods */
    		this.rowTransformer = new LocalToMapRowTransformer<C, K, V>(rowClass, (Set) getColumns(), this::getKey, this::toMapValue);
    	}

    	public T getTargetTable() {
    		return targetTable;
    	}

    	@Override
    	public Set<Column<T, ?>> getColumns() {
    		return columns;
    	}

    	@Override
    	public RowTransformer<C> getRowTransformer() {
    		return rowTransformer;
    	}

    	@Override
    	public void addPropertySetByConstructor(PropertyAccessPoint<C, ?> accessor) {
    		// this class doesn't support bean factory so it can't support properties set by constructor
    	}

    	protected String getColumnName(String columnsPrefix, int i) {
    		return columnsPrefix + i;
    	}

    	@Override
    	public Map<Column<T, ?>, Object> getInsertValues(C c) {
    		Map<Column<T, ?>, Object> toReturn = new HashMap<>();
    		Map<K, V> toIterate = c;
    		if (Collections.isEmpty(c)) {
    			toIterate = new HashMap<>();
    		}
    		toIterate.forEach((key, value) -> addUpsertValues(key, value, toReturn));
    		// NB: we must return all columns: we complete non-valued columns with null
    		for (Column<T, ?> column : columns) {
    			if (!toReturn.containsKey(column)) {
    				toReturn.put(column, null);
    			}
    		}
    		return toReturn;
    	}

    	@Override
    	public Map<UpwhereColumn<T>, ?> getUpdateValues(C modified, C unmodified, boolean allColumns) {
    		Map<Column<T, ?>, Object> unmodifiedColumns = new HashMap<>();
    		Map<Column<T, ?>, Object> toReturn = new HashMap<>();
    		if (modified != null) {
    			// getting differences
    			// - all of modified but different in unmodified
    			for (Entry<K, V> modifiedEntry : modified.entrySet()) {
    				K modifiedKey = modifiedEntry.getKey();
    				V modifiedValue = modifiedEntry.getValue();
    				Column<T, ?> column = getColumn(modifiedKey);
    				if (!Predicates.equalOrNull(modifiedValue, unmodified == null ? null : unmodified.get(modifiedKey))) {
    					toReturn.put(column, modifiedValue);
    				} else {
    					unmodifiedColumns.put(column, modifiedValue);
    				}
    			}
    			// - all from unmodified missing in modified
    			HashSet<K> missingInModified = unmodified == null ? new HashSet<>() : new HashSet<>(unmodified.keySet());
    			missingInModified.removeAll(modified.keySet());
    			for (K k : missingInModified) {
    				addUpsertValues(k, modified.get(k), toReturn);
    			}

    			// adding complementary columns if necessary
    			if (allColumns && !toReturn.isEmpty()) {
    				Set<Column<T, ?>> missingColumns = new LinkedHashSet<>(columns);
    				missingColumns.removeAll(toReturn.keySet());
    				for (Column<T, ?> missingColumn : missingColumns) {
    					Object missingValue = unmodifiedColumns.get(missingColumn);
    					toReturn.put(missingColumn, missingValue);
    				}
    			}
    		} else if (allColumns && unmodified != null) {
    			for (Column<T, ?> column : columns) {
    				toReturn.put(column, null);
    			}
    		}
    		return convertToUpwhereColumn(toReturn);
    	}

    	private Map<UpwhereColumn<T>, Object> convertToUpwhereColumn(Map<Column<T, ?>, Object> map) {
    		Map<UpwhereColumn<T>, Object> convertion = new HashMap<>();
    		map.forEach((c, s) -> convertion.put(new UpwhereColumn<>(c, true), s));
    		return convertion;
    	}

    	/**
    	 * Add values to valuesToBePersisted according to key and value.
    	 * Calls {@link #toDatabaseValue(Object, Object)} to transform value to the persisted Object
    	 *
    	 * @param key the key to be persisted
    	 * @param value the value ok key in the Map, may be transformed to be persisted
    	 * @param valuesToBePersisted Map to populate
    	 */
    	protected void addUpsertValues(K key, V value, Map<Column<T, ?>, Object> valuesToBePersisted) {
    		Object o = toDatabaseValue(key, value);
    		Column<T, ?> column = getColumn(key);
    		valuesToBePersisted.put(column, o);
    	}

    	protected abstract Column<T, ?> getColumn(K k);

    	/**
    	 * Expected to return the persisted value for v of key k
    	 * @param k the key being persisted, help to determine how to convert v
    	 * @param v the value to be persisted
    	 * @return the dabase value to be persisted
    	 */
    	protected abstract Object toDatabaseValue(K k, V v);

    	/**
    	 * Reverse of {@link #getColumn(Object)}: give a map key from a column name
    	 * @param column
    	 * @return a key for a Map
    	 */
    	protected abstract K getKey(Column column);

    	/**
    	 * Reverse of {@link #toDatabaseValue(Object, Object)}: give a map value from a database selected value
    	 * @param k the key being read, help to determine how to convert t
    	 * @param o the data from the database
    	 * @return a value for a Map
    	 */
    	protected abstract V toMapValue(K k, Object o);

    	@Override
    	public C transform(ColumnedRow row) {
    		return this.rowTransformer.transform(row);
    	}

    	@Override
    	public Map<ReadWritePropertyAccessPoint<C, ?>, Column<T, ?>> getPropertyToColumn() {
    		throw new UnsupportedOperationException(Reflections.toString(ColumnedMapMapping.class) + " can't export a mapping between some accessors and their columns");
    	}

    	@Override
    	public Map<PropertyMutator<C, ?>, Column<T, ?>> getReadonlyPropertyToColumn() {
    		throw new UnsupportedOperationException(Reflections.toString(ColumnedMapMapping.class) + " can't export a mapping between some accessors and their columns");
    	}

    	@Override
    	public Set<Column<T, ?>> getWritableColumns() {
    		return this.columns;
    	}

    	@Override
    	public Set<Column<T, ?>> getReadonlyColumns() {
    		return java.util.Collections.emptySet();
    	}

    	private static class LocalToMapRowTransformer<M extends Map<K, V>, K, V> extends ToMapRowTransformer<M> {

    		private final Iterable<Column> columns;
    		private final Function<Column, K> keyProvider;
    		private final BiFunction<K /* key */, Object /* row value */, V> databaseValueConverter;

    		private LocalToMapRowTransformer(Class<M> persistedClass,
    										 Iterable<Column> columns,
    										 Function<Column, K> keyProvider,
    										 BiFunction<K /* key */, Object /* row value */, V> databaseValueConverter) {
    			super(persistedClass);
    			this.columns = columns;
    			this.keyProvider = keyProvider;
    			this.databaseValueConverter = databaseValueConverter;
    		}

    		private LocalToMapRowTransformer(Function<ColumnedRow, M> beanFactory,
    										 Iterable<Column> columns, Function<Column, K> keyProvider,
    										 BiFunction<K /* key */, Object /* row value */, V> databaseValueConverter) {
    			super(beanFactory);
    			this.columns = columns;
    			this.keyProvider = keyProvider;
    			this.databaseValueConverter = databaseValueConverter;
    		}

    		/** We bind conversion on {@link ColumnedCollectionMapping} conversion methods */
    		@Override
    		public void applyRowToBean(ColumnedRow row, M map) {
    			for (Column<?, ?> column : this.columns) {
    				K key = keyProvider.apply(column);
    				V value = (V) row.get(column);
    				map.put(key, databaseValueConverter.apply(key, value));
    			}
    		}
    	}
    }